Micron Document
🎖️GitЯра🎖️

Node / meshtastic / Meshtastic-Android / files / core / network / src / commonMain / kotlin / org / meshtastic / core / network / radio / TransportLifecycleGate.kt

Displaying Raw • Download

core/network/src/commonMain/kotlin/org/meshtastic/core/network/radio/TransportLifecycleGate.kt bd2863243bab6eb213401d949839a2bc74dde7e2 (bd286324) Text, 8.74 KB

T8b949e/*
* Copyright (c) 2026 Meshtastic LLC
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
Tff7b72package T7ee787org.meshtastic.core.network.radio

Tff7b72import T7ee787co.touchlab.kermit.Logger
Tff7b72import T7ee787kotlinx.atomicfu.atomic
Tff7b72import T7ee787kotlinx.atomicfu.locks.SynchronizedObject
Tff7b72import T7ee787kotlinx.atomicfu.locks.synchronized
Tff7b72import T7ee787kotlinx.coroutines.CancellationException
Tff7b72import T7ee787kotlinx.coroutines.CompletableDeferred
Tff7b72import T7ee787kotlinx.coroutines.NonCancellable
Tff7b72import T7ee787kotlinx.coroutines.withContext
Tff7b72import T7ee787kotlinx.coroutines.withTimeoutOrNull
Tff7b72import T7ee787kotlin.time.Duration
Tff7b72import T7ee787kotlin.time.Duration.Companion.seconds

T8b949e/** Linearizes admitted transport operations with terminal, idempotent teardown. */
Tff7b72internal Tff7b72class T56d364TransportLifecycleGateTb4b4b4(
Tff7b72private Tff7b72val Te6edf3labelTb4b4b4: Tffa657StringTb4b4b4,
Tff7b72private Tff7b72val Te6edf3operationDrainTimeoutTb4b4b4: Te6edf3Duration Tff7b72= Te6edf3OPERATION_DRAIN_TIMEOUTTb4b4b4,
Tff7b72private Tff7b72val Te6edf3teardownTimeoutTb4b4b4: Te6edf3Duration Tff7b72= Te6edf3TEARDOWN_TIMEOUTTb4b4b4,
Tb4b4b4) Tb4b4b4{
Tff7b72internal Tff7b72companion Tff7b72object Tb4b4b4{
Tff7b72val Te6edf3OPERATION_DRAIN_TIMEOUT Tff7b72= T79c0ff1T79c0ff5.Te6edf3seconds
Tff7b72val Te6edf3TEARDOWN_TIMEOUT Tff7b72= T79c0ff1T79c0ff5.Te6edf3seconds
Tb4b4b4}

Tff7b72private Tff7b72val Te6edf3lock Tff7b72= Te6edf3SynchronizedObjectTb4b4b4(Tb4b4b4)
Tff7b72private Tff7b72val Te6edf3closed Tff7b72= Te6edf3atomicTb4b4b4(Tff7b72falseTb4b4b4)
Tff7b72private Tff7b72var Te6edf3admittedOperations Tff7b72= T79c0ff0
Tff7b72private Tff7b72var Te6edf3operationDrainWaiterTb4b4b4: Te6edf3CompletableDeferredTff7b72<Tffa657UnitTff7b72>Tff7b72? Tff7b72= Tff7b72null
Tff7b72private Tff7b72var Te6edf3closeCompletionTb4b4b4: Te6edf3CompletableDeferredTff7b72<Tffa657BooleanTff7b72>Tff7b72? Tff7b72= Tff7b72null

Tff7b72val Te6edf3isClosedTb4b4b4: Tffa657Boolean
Tff7b72getTb4b4b4(Tb4b4b4) Tff7b72= Te6edf3closedTb4b4b4.Te6edf3value

T8b949e/** One admitted operation. Release exactly once when the externally visible work has actually finished. */
Tff7b72internal Tff7b72class T56d364OperationLease Te6edf3internal Tff7b72constructorTb4b4b4(Tff7b72private Tff7b72val Te6edf3releaseActionTb4b4b4: Tb4b4b4(Tb4b4b4) Tff7b72-Tff7b72> Tffa657UnitTb4b4b4) Tb4b4b4{
Tff7b72private Tff7b72val Te6edf3released Tff7b72= Te6edf3atomicTb4b4b4(Tff7b72falseTb4b4b4)

Tff7b72fun Td2a8ffreleaseTb4b4b4(Tb4b4b4) Tb4b4b4{
Tff7b72if Tb4b4b4(Te6edf3releasedTb4b4b4.Te6edf3compareAndSetTb4b4b4(Te6edf3expect Tff7b72= Tff7b72falseTb4b4b4, Te6edf3update Tff7b72= Tff7b72trueTb4b4b4)Tb4b4b4) Te6edf3releaseActionTb4b4b4(Tb4b4b4)
Tb4b4b4}
Tb4b4b4}

T8b949e/** Acquires an operation lease, or returns `null` once close has begun. */
Tff7b72fun Td2a8fftryAcquireTb4b4b4(Tb4b4b4)Tb4b4b4: Te6edf3OperationLease? Tff7b72= Te6edf3synchronizedTb4b4b4(Te6edf3lockTb4b4b4) Tb4b4b4{
Tff7b72if Tb4b4b4(Te6edf3closedTb4b4b4.Te6edf3valueTb4b4b4) Tff7b72returnTf0883e@synchronized Tff7b72null
Te6edf3admittedOperationsTff7b72+Tff7b72+
Te6edf3OperationLeaseTb4b4b4(Tff7b72::Te6edf3releaseOperationTb4b4b4)
Tb4b4b4}

T8b949e/** Runs [block] outside the gate lock after admission, or returns `null` once close has begun. */
Tff7b72fun Tff7b72<Te6edf3T Tb4b4b4: Te6edf3AnyTff7b72> Td2a8ffrunIfOpenTb4b4b4(Te6edf3blockTb4b4b4: Tb4b4b4(Tb4b4b4) Tff7b72-Tff7b72> Te6edf3TTb4b4b4)Tb4b4b4: Te6edf3T? Tb4b4b4{
Tff7b72val Te6edf3lease Tff7b72= Te6edf3tryAcquireTb4b4b4(Tb4b4b4) Tff7b72?: Tff7b72return Tff7b72null
Tff7b72return Tff7b72try Tb4b4b4{
Te6edf3blockTb4b4b4(Tb4b4b4)
Tb4b4b4} Tff7b72finally Tb4b4b4{
Te6edf3leaseTb4b4b4.Te6edf3releaseTb4b4b4(Tb4b4b4)
Tb4b4b4}
Tb4b4b4}

T8b949e/**
* Closes admission, cooperatively bounds [beforeDrain], drains admitted work, and then bounds [teardown].
*
* [beforeDrain] lets an owner stop an internal worker whose completion releases operation leases. Admission is
* already closed before it runs, so callbacks caused by that preparation cannot escape the gate. Both phases
* execute exactly once.
*
* [NonCancellable] keeps callers from abandoning shared close ownership, while the nested timeouts can still cancel
* cooperative work. They cannot bound a teardown lambda that blocks a thread without a cancellation point, or a
* nested [close] that has entered its own [NonCancellable] ownership. Owners that nest lifecycle closes must size
* their outer timeout to include the nested drain/teardown budget, and potentially blocking platform work must
* remain interruptible. Returns `true` only when preparation, the admitted-operation drain, and teardown all
* complete within their bounds. A phase failure is recorded on the shared completion and rethrown to every closer;
* the gate is deliberately not reopened or retried after a poisoned close.
*/
Tf0883e@SuppressTb4b4b4(Ta5d6ff"Ta5d6ffTooGenericExceptionCaughtTa5d6ff"Tb4b4b4)
Tff7b72suspend Tff7b72fun Td2a8ffcloseTb4b4b4(Te6edf3beforeDrainTb4b4b4: Te6edf3suspend Tb4b4b4(Tb4b4b4) Tff7b72-Tff7b72> Tffa657Unit Tff7b72= Tb4b4b4{Tb4b4b4}Tb4b4b4, Te6edf3teardownTb4b4b4: Te6edf3suspend Tb4b4b4(Tb4b4b4) Tff7b72-Tff7b72> Tffa657Unit Tff7b72= Tb4b4b4{Tb4b4b4}Tb4b4b4)Tb4b4b4: Tffa657Boolean Tff7b72=
Te6edf3withContextTb4b4b4(Te6edf3NonCancellableTb4b4b4) Tb4b4b4{
Tff7b72val Te6edf3plan Tff7b72= Te6edf3closePlanTb4b4b4(Tb4b4b4)
Tff7b72if Tb4b4b4(Tff7b72!Te6edf3planTb4b4b4.Te6edf3ownerTb4b4b4) Tff7b72returnTf0883e@withContext Te6edf3planTb4b4b4.Te6edf3completionTb4b4b4.Te6edf3awaitTb4b4b4(Tb4b4b4)

Tff7b72try Tb4b4b4{
Tff7b72val Te6edf3preparation Tff7b72= Te6edf3prepareForCloseTb4b4b4(Te6edf3beforeDrainTb4b4b4)
Te6edf3logPreparationResultTb4b4b4(Te6edf3preparationTb4b4b4)
Tff7b72val Te6edf3drained Tff7b72= Te6edf3awaitOperationDrainTb4b4b4(Te6edf3planTb4b4b4.Te6edf3operationDrainTb4b4b4)
Tff7b72val Te6edf3tornDown Tff7b72= Te6edf3runTeardownTb4b4b4(Te6edf3teardownTb4b4b4)
Tb4b4b4(Te6edf3preparation Tff7b72as? Te6edf3ClosePreparationTb4b4b4.Te6edf3FailedTb4b4b4)Tff7b72?.Te6edf3failureTff7b72?.Te6edf3let Tb4b4b4{ Tff7b72throw Tffa657it Tb4b4b4}

Tff7b72val Te6edf3completed Tff7b72= Te6edf3preparation Tff7b72=Tff7b72=Tff7b72= Te6edf3ClosePreparationTb4b4b4.Te6edf3Completed Tff7b72&Tff7b72& Te6edf3drained Tff7b72&Tff7b72& Te6edf3tornDown
Te6edf3planTb4b4b4.Te6edf3completionTb4b4b4.Te6edf3completeTb4b4b4(Te6edf3completedTb4b4b4)
Te6edf3completed
Tb4b4b4} Tff7b72catch Tb4b4b4(Te6edf3failureTb4b4b4: Te6edf3ThrowableTb4b4b4) Tb4b4b4{
Te6edf3planTb4b4b4.Te6edf3completionTb4b4b4.Te6edf3completeExceptionallyTb4b4b4(Te6edf3failureTb4b4b4)
Tff7b72throw Te6edf3failure
Tb4b4b4} Tff7b72finally Tb4b4b4{
Tff7b72if Tb4b4b4(Tff7b72!Te6edf3planTb4b4b4.Te6edf3completionTb4b4b4.Te6edf3isCompletedTb4b4b4) Te6edf3planTb4b4b4.Te6edf3completionTb4b4b4.Te6edf3completeTb4b4b4(Tff7b72falseTb4b4b4)
Tb4b4b4}
Tb4b4b4}

Tff7b72private Tff7b72fun Td2a8ffclosePlanTb4b4b4(Tb4b4b4)Tb4b4b4: Te6edf3ClosePlan Tff7b72= Te6edf3synchronizedTb4b4b4(Te6edf3lockTb4b4b4) Tb4b4b4{
Tff7b72if Tb4b4b4(Te6edf3closedTb4b4b4.Te6edf3valueTb4b4b4) Tb4b4b4{
Te6edf3ClosePlanTb4b4b4(Te6edf3owner Tff7b72= Tff7b72falseTb4b4b4, Te6edf3completion Tff7b72= Te6edf3checkNotNullTb4b4b4(Te6edf3closeCompletionTb4b4b4)Tb4b4b4, Te6edf3operationDrain Tff7b72= Tff7b72nullTb4b4b4)
Tb4b4b4} Tff7b72else Tb4b4b4{
Te6edf3closedTb4b4b4.Te6edf3value Tff7b72= Tff7b72true
Tff7b72val Te6edf3completion Tff7b72= Te6edf3CompletableDeferredTff7b72<Tffa657BooleanTff7b72>Tb4b4b4(Tb4b4b4)Tb4b4b4.Te6edf3also Tb4b4b4{ Te6edf3closeCompletion Tff7b72= Tffa657it Tb4b4b4}
Tff7b72val Te6edf3operationDrain Tff7b72=
Tff7b72if Tb4b4b4(Te6edf3admittedOperations Tff7b72=Tff7b72= T79c0ff0Tb4b4b4) Tb4b4b4{
Tff7b72null
Tb4b4b4} Tff7b72else Tb4b4b4{
Te6edf3operationDrainWaiter Tff7b72?: Te6edf3CompletableDeferredTff7b72<Tffa657UnitTff7b72>Tb4b4b4(Tb4b4b4)Tb4b4b4.Te6edf3also Tb4b4b4{ Te6edf3operationDrainWaiter Tff7b72= Tffa657it Tb4b4b4}
Tb4b4b4}
Te6edf3ClosePlanTb4b4b4(Te6edf3owner Tff7b72= Tff7b72trueTb4b4b4, Te6edf3completion Tff7b72= Te6edf3completionTb4b4b4, Te6edf3operationDrain Tff7b72= Te6edf3operationDrainTb4b4b4)
Tb4b4b4}
Tb4b4b4}

Tf0883e@SuppressTb4b4b4(Ta5d6ff"Ta5d6ffTooGenericExceptionCaughtTa5d6ff"Tb4b4b4)
Tff7b72private Tff7b72suspend Tff7b72fun Td2a8ffprepareForCloseTb4b4b4(Te6edf3beforeDrainTb4b4b4: Te6edf3suspend Tb4b4b4(Tb4b4b4) Tff7b72-Tff7b72> Tffa657UnitTb4b4b4)Tb4b4b4: Te6edf3ClosePreparation Tff7b72=
Te6edf3withTimeoutOrNullTb4b4b4(Te6edf3operationDrainTimeoutTb4b4b4) Tb4b4b4{
Tff7b72try Tb4b4b4{
Te6edf3beforeDrainTb4b4b4(Tb4b4b4)
Te6edf3ClosePreparationTb4b4b4.Te6edf3Completed
Tb4b4b4} Tff7b72catch Tb4b4b4(Te6edf3cancellationTb4b4b4: Te6edf3CancellationExceptionTb4b4b4) Tb4b4b4{
Tff7b72throw Te6edf3cancellation
Tb4b4b4} Tff7b72catch Tb4b4b4(Te6edf3failureTb4b4b4: Te6edf3ThrowableTb4b4b4) Tb4b4b4{
Te6edf3ClosePreparationTb4b4b4.Te6edf3FailedTb4b4b4(Te6edf3failureTb4b4b4)
Tb4b4b4}
Tb4b4b4} Tff7b72?: Te6edf3ClosePreparationTb4b4b4.Te6edf3TimedOut

Tff7b72private Tff7b72fun Td2a8fflogPreparationResultTb4b4b4(Te6edf3preparationTb4b4b4: Te6edf3ClosePreparationTb4b4b4) Tb4b4b4{
Tff7b72when Tb4b4b4(Te6edf3preparationTb4b4b4) Tb4b4b4{
Te6edf3ClosePreparationTb4b4b4.Te6edf3Completed Tff7b72-Tff7b72> Tffa657Unit

Te6edf3ClosePreparationTb4b4b4.Te6edf3TimedOut Tff7b72-Tff7b72>
Te6edf3LoggerTb4b4b4.Te6edf3w Tb4b4b4{ Ta5d6ff"Tffd700$Te6edf3labelTa5d6ff transport close preparation timed out after Tffd700$Te6edf3operationDrainTimeoutTa5d6ff" Tb4b4b4}

Tff7b72is Te6edf3ClosePreparationTb4b4b4.Te6edf3Failed Tff7b72-Tff7b72> Te6edf3LoggerTb4b4b4.Te6edf3wTb4b4b4(Te6edf3preparationTb4b4b4.Te6edf3failureTb4b4b4) Tb4b4b4{ Ta5d6ff"Tffd700$Te6edf3labelTa5d6ff transport close preparation failedTa5d6ff" Tb4b4b4}
Tb4b4b4}
Tb4b4b4}

Tff7b72private Tff7b72suspend Tff7b72fun Td2a8ffawaitOperationDrainTb4b4b4(Te6edf3operationDrainTb4b4b4: Te6edf3CompletableDeferredTff7b72<Tffa657UnitTff7b72>Tff7b72?Tb4b4b4)Tb4b4b4: Tffa657Boolean Tb4b4b4{
Tff7b72val Te6edf3drained Tff7b72=
Te6edf3operationDrain Tff7b72=Tff7b72= Tff7b72null Tff7b72|Tff7b72|
Te6edf3withTimeoutOrNullTb4b4b4(Te6edf3operationDrainTimeoutTb4b4b4) Tb4b4b4{
Te6edf3operationDrainTb4b4b4.Te6edf3awaitTb4b4b4(Tb4b4b4)
Tff7b72true
Tb4b4b4} Tff7b72=Tff7b72= Tff7b72true
Tff7b72if Tb4b4b4(Tff7b72!Te6edf3drainedTb4b4b4) Tb4b4b4{
Te6edf3LoggerTb4b4b4.Te6edf3w Tb4b4b4{
Ta5d6ff"Tffd700$Te6edf3labelTa5d6ff transport close timed out after Tffd700$Te6edf3operationDrainTimeoutTa5d6ff while draining admitted operationsTa5d6ff"
Tb4b4b4}
Tb4b4b4}
Tff7b72return Te6edf3drained
Tb4b4b4}

Tff7b72private Tff7b72suspend Tff7b72fun Td2a8ffrunTeardownTb4b4b4(Te6edf3teardownTb4b4b4: Te6edf3suspend Tb4b4b4(Tb4b4b4) Tff7b72-Tff7b72> Tffa657UnitTb4b4b4)Tb4b4b4: Tffa657Boolean Tb4b4b4{
Tff7b72val Te6edf3tornDown Tff7b72=
Te6edf3withTimeoutOrNullTb4b4b4(Te6edf3teardownTimeoutTb4b4b4) Tb4b4b4{
Te6edf3teardownTb4b4b4(Tb4b4b4)
Tff7b72true
Tb4b4b4} Tff7b72=Tff7b72= Tff7b72true
Tff7b72if Tb4b4b4(Tff7b72!Te6edf3tornDownTb4b4b4) Te6edf3LoggerTb4b4b4.Te6edf3w Tb4b4b4{ Ta5d6ff"Tffd700$Te6edf3labelTa5d6ff transport teardown timed out after Tffd700$Te6edf3teardownTimeoutTa5d6ff" Tb4b4b4}
Tff7b72return Te6edf3tornDown
Tb4b4b4}

Tff7b72private Tff7b72sealed Tff7b72interface T56d364ClosePreparation Tb4b4b4{
Tff7b72data Tff7b72object T56d364Completed Tb4b4b4: Te6edf3ClosePreparation

Tff7b72data Tff7b72object T56d364TimedOut Tb4b4b4: Te6edf3ClosePreparation

Tff7b72data Tff7b72class T56d364FailedTb4b4b4(Tff7b72val Te6edf3failureTb4b4b4: Te6edf3ThrowableTb4b4b4) Tb4b4b4: Te6edf3ClosePreparation
Tb4b4b4}

Tff7b72private Tff7b72data Tff7b72class T56d364ClosePlanTb4b4b4(
Tff7b72val Te6edf3ownerTb4b4b4: Tffa657BooleanTb4b4b4,
Tff7b72val Te6edf3completionTb4b4b4: Te6edf3CompletableDeferredTff7b72<Tffa657BooleanTff7b72>Tb4b4b4,
Tff7b72val Te6edf3operationDrainTb4b4b4: Te6edf3CompletableDeferredTff7b72<Tffa657UnitTff7b72>Tff7b72?Tb4b4b4,
Tb4b4b4)

Tff7b72private Tff7b72fun Td2a8ffreleaseOperationTb4b4b4(Tb4b4b4) Tb4b4b4{
Tff7b72val Te6edf3waiter Tff7b72=
Te6edf3synchronizedTb4b4b4(Te6edf3lockTb4b4b4) Tb4b4b4{
Tff7b72if Tb4b4b4(Te6edf3admittedOperations Tff7b72<Tff7b72= T79c0ff0Tb4b4b4) Tb4b4b4{
Te6edf3LoggerTb4b4b4.Te6edf3e Tb4b4b4{ Ta5d6ff"Tffd700$Te6edf3labelTa5d6ff transport lifecycle operation count underflowTa5d6ff" Tb4b4b4}
Te6edf3operationDrainWaiterTb4b4b4.Te6edf3also Tb4b4b4{ Te6edf3operationDrainWaiter Tff7b72= Tff7b72null Tb4b4b4}
Tb4b4b4} Tff7b72else Tb4b4b4{
Te6edf3admittedOperationsTff7b72-Tff7b72-
Tff7b72if Tb4b4b4(Te6edf3admittedOperations Tff7b72=Tff7b72= T79c0ff0Tb4b4b4) Tb4b4b4{
Te6edf3operationDrainWaiterTb4b4b4.Te6edf3also Tb4b4b4{ Te6edf3operationDrainWaiter Tff7b72= Tff7b72null Tb4b4b4}
Tb4b4b4} Tff7b72else Tb4b4b4{
Tff7b72null
Tb4b4b4}
Tb4b4b4}
Tb4b4b4}
Te6edf3waiterTff7b72?.Te6edf3completeTb4b4b4(Tffa657UnitTb4b4b4)
Tb4b4b4}
Tb4b4b4}

Served by rngit 1.5.0 - Generated in 0.11s